dundas.controls.DashboardCanvas Class

Inheritance Hierarchy

Constructors

	Name	Description
	init	Attaches a designer control to the specified div container. Inherited from dundas.controls.Canvas.

Properties

	Name	Description
	activeGridTemplateAdorner	Gets the active GridTemplateAdorner in edit mode. Inherited from dundas.controls.Canvas.
	canvasAdapter	Gets the canvas adapter. Inherited from dundas.controls.Canvas.
	collapsePlayground	Inherited from dundas.controls.Canvas.
	contextFocused	Gets all the adapters that are contextually focused. Inherited from dundas.controls.Canvas.
	controlContainer	Gets the container of this control. Inherited from dundas.controls.FocusableControl.
	designBackground	Inherited from dundas.controls.Canvas.
	gridTemplateAdorner	Gets the default GridTemplateAdorner Inherited from dundas.controls.Canvas.
	gridTemplateAdorners	Gets all the GridTemplateAdorners used in this canvas. Inherited from dundas.controls.Canvas.
	height	The height of the canvas. Inherited from dundas.controls.Canvas.
	initialized	Gets the value indicating whether the canvas is initialized and ready Inherited from dundas.controls.Canvas.
	isDisabled	Gets or sets whether or not this control is disabled. Inherited from dundas.controls.FocusableControl.
	isDisposed	Gets a value indicating whether this instance has been disposed. Inherited from dundas.EventDisposable.
	isFocused	Gets or sets the focused state of this control. Inherited from dundas.controls.FocusableControl.
	isInModalViewMode	Get a value to indicate whether ot not the canva sis in Model view mode. Inherited from dundas.controls.Canvas.
	isInViewMode	Get or set the ViewMode Inherited from dundas.controls.Canvas.
	isLoading	Inherited from dundas.controls.Canvas.
	isResizerVisible	Inherited from dundas.controls.Canvas.
	isSubCanvas	Gets the value to indicate whether or not this is a subcanvas. Inherited from dundas.controls.Canvas.
	jQControlContainer	Gets the container of this control in JQuery object. Inherited from dundas.controls.FocusableControl.
	layerManager	Gets the layer manager Inherited from dundas.controls.Canvas.
	loadedTemplateCells	Inherited from dundas.controls.Canvas.
	modalAdapter	Get the adapter that is showing in modal mode. Inherited from dundas.controls.Canvas.
	pageHeight	The height of a single virtualized page. Inherited from dundas.controls.Canvas.
	pageWidth	The width of a single virtualized page. Inherited from dundas.controls.Canvas.
	parentFocusable	Gets the focusable parent of this control. Inherited from dundas.controls.FocusableControl.
	resizeMode	Inherited from dundas.controls.Canvas.
	rulerSize	Get the ruler size Inherited from dundas.controls.Canvas.
	scale	Gets the horizontal scaling factor. Inherited from dundas.controls.Canvas.
	scaledViewportHeight	Gets the height of the contained area inside the viewport in pixels. Inherited from dundas.controls.Canvas.
	scaledViewportWidth	Gets the width of the contained area inside the viewport in pixels. Inherited from dundas.controls.Canvas.
	scaleY	Gets the vertical scaling factor. Inherited from dundas.controls.Canvas.
	selectedLayer	Inherited from dundas.controls.Canvas.
	selectionAdorner	Gets the SelectionAdorner Inherited from dundas.controls.Canvas.
	templateViewModel	Get the view model of the template canvas Inherited from dundas.controls.Canvas.
	uiCache	Gets the UI cache table Inherited from dundas.EventDisposable.
	viewContainer	Gets the view container that contains this canvas. Inherited from dundas.controls.Canvas.
	viewModel	Get the view model of the canvas Inherited from dundas.controls.Canvas.
	viewportHeight	Gets the height of the viewport in pixels. Inherited from dundas.controls.Canvas.
	viewportWidth	Gets the width of the viewport in pixels. Inherited from dundas.controls.Canvas.
	visibleTemplateCells	Inherited from dundas.controls.Canvas.
	width	The Width of the canvas. Inherited from dundas.controls.Canvas.

Methods

	Name	Description
	adjustCellSpacing	Adjust the cell spacings and cell paddings according to the canvas adapter. Inherited from dundas.controls.Canvas.
	align	Align the viewmodels. Inherited from dundas.controls.Canvas.
	alignTo	Inherited from dundas.controls.Canvas.
	appendTemplateCellColumns	Append new columns of template cells Inherited from dundas.controls.Canvas.
	appendTemplateCellRows	Append new rows of template cells Inherited from dundas.controls.Canvas.
	bind	Bind an event to this class object. Inherited from dundas.EventDisposable.
	borderHint	Border highlight the adapters or view models. Unhighlight any previously border highlighted items Inherited from dundas.controls.Canvas.
	centerView	Places the current view port to the center of the playground. Inherited from dundas.controls.Canvas.
	clearTemplate	Clears the template being used. Inherited from dundas.controls.Canvas.
	copy	Perform a clipboard copy. Inherited from dundas.controls.Canvas.
	createCanvasObjects	Add a designer object to the design surface. Inherited from dundas.controls.Canvas.
	createLayer	Inherited from dundas.controls.Canvas.
	createSelectionGroupVm	Create a selection group view model and make the canvas react to its changes. Inherited from dundas.controls.Canvas.
	cut	Perform a clipboard cut. Inherited from dundas.controls.Canvas.
	determineTemplateCellVisible	Inherited from dundas.controls.Canvas.
	dispose	Disposes the canvas. Inherited from dundas.EventDisposable.
	distribute	Equally distribute the spacing between the viewModels. Inherited from dundas.controls.Canvas.
	focus	Put this control into focus. Inherited from dundas.controls.FocusableControl.
	fromJObject	Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
	getAllGroups	Get all groups. Inherited from dundas.controls.Canvas.
	getAllViewModels	Retrieve all view models. Inherited from dundas.controls.Canvas.
	getCanvasContainerPageBound	Gets the canvas control container's bounding client rectangle. Inherited from dundas.controls.Canvas.
	getCanvasDebugPrefix	Inherited from dundas.controls.Canvas.
	getCenter	Gets the center coordinate of the middle of the current view. Inherited from dundas.controls.Canvas.
	getClosestTemplateCell	Retrieves the closest templateCell relative to toCheckRectangle of the current layer. Inherited from dundas.controls.Canvas.
	getContainerTemplateCell	Inherited from dundas.controls.Canvas.
	getContextState	Set the UI context state to be saved in dundas.UIContextFocus Inherited from dundas.controls.FocusableControl.
	getDesignBackgroundOffset	Gets the design background offset value. Inherited from dundas.controls.Canvas.
	getDesignBackgrounds	Retrieve the design background (actual area of the dashboard). The design background Inherited from dundas.controls.Canvas.
	getDesignBackgroundsContainerSize	Inherited from dundas.controls.Canvas.
	getDesignBackgroundSize	Inherited from dundas.controls.Canvas.
	getDesignObjects	Get all design objects from the canvas. Inherited from dundas.controls.Canvas.
	getDesignPlayground	Retrieve the design playground DOM. Inherited from dundas.controls.Canvas.
	getDesignPlaygroundSize	Gets the design playground width and height. Inherited from dundas.controls.Canvas.
	getGroup	Get group. Inherited from dundas.controls.Canvas.
	getLayerManager	Retrieves the layer manager of the canvas. Inherited from dundas.controls.Canvas.
	getPlaygroundOffset	Gets the playground offset. Inherited from dundas.controls.Canvas.
	getTemplateCellById	Retrieve the template cell view model by the ID. Inherited from dundas.controls.Canvas.
	getTemplateCellsByPage	Retrieve the template cells of the desired page. Inherited from dundas.controls.Canvas.
	getTransactionFactory	Retrieves the transaction factory of this canvas. Inherited from dundas.controls.Canvas.
	getViewModelFromElement	Inherited from dundas.controls.Canvas.
	getViewModels	Retrieves the viewModels of adapters. Inherited from dundas.controls.Canvas.
	getVision	Get the current vision. (left, top and scale) Inherited from dundas.controls.Canvas.
	group	Group the design object or existing groups. Inherited from dundas.controls.Canvas.
	groupTemplateCells	Group the template cells. Inherited from dundas.controls.Canvas.
	hideDropZones	Hide drop zones. Inherited from dundas.controls.Canvas.
	hideResizer	Hides the template cell resizer. Inherited from dundas.controls.Canvas.
	highlight	Highlight the adapters or view models. Unhighlight any previously highlighted items Inherited from dundas.controls.Canvas.
	loadCanvas	Load the canvas with data. Inherited from dundas.controls.Canvas.
	loadTemplate	Load a template, or template cells. Inherited from dundas.controls.Canvas.
	manipulateCanvasObjects	Manipulate the position and size of a canvas object. Inherited from dundas.controls.Canvas.
	onContextMenu	Fires when the user does a context click on the canvas. Inherited from dundas.controls.Canvas.
	onDragEnter	Fires when something enters the canvas. Inherited from dundas.controls.Canvas.
	onDragLeave	Fires when something leaves the canvas. Inherited from dundas.controls.Canvas.
	onDragOver	Fires when something is dragged-over the canvas. Inherited from dundas.controls.Canvas.
	onDrop	Fires when something is dropped on the canvas. Inherited from dundas.controls.Canvas.
	onPasteComplete	Fires the Pasted event when callback is null. Register callback as an event handler otherwise. Inherited from dundas.controls.Canvas.
	onVisionChanged	Fires the VisionChanged event when callback is null. Register callback as an event handler otherwise. Inherited from dundas.controls.Canvas.
	onVisionChangeStart	Fires the VisionChangeStart event when callback is null. Register callback as an event handler otherwise. Inherited from dundas.controls.Canvas.
	onVisionChanging	Fires the VisionChanging event when callback is null. Register callback as an event handler otherwise. Inherited from dundas.controls.Canvas.
	paste	Perform a clipboard paste. Inherited from dundas.controls.Canvas.
	raiseBindEvent	Fire the event specified with eventName, or subscribe a handler. Inherited from dundas.EventDisposable.
	reInvalidateAdapters	Re-assign the top, left, width, and height properties of the adapters to effectively make them re-render. Inherited from dundas.controls.Canvas.
	releaseAdapterContextFocus	Inherited from dundas.controls.Canvas.
	releaseModalAdapter	Inherited from dundas.controls.Canvas.
	removeCanvasObjects	Remove a design object from the canvas. Inherited from dundas.controls.Canvas.
	removeLayer	Inherited from dundas.controls.Canvas.
	resetTemplateLayer	remove the template visually and put everything as absolute positioning relative to the background Inherited from dundas.controls.Canvas.
	resizeBackground	Resizes the canvas background (actual dashboard surface). Inherited from dundas.controls.Canvas.
	saveCanvas	Inherited from dundas.controls.Canvas.
	scrollIntoView	Best effort to try to scroll the canvas so that all of the viewmodels are visible Inherited from dundas.controls.Canvas.
	setActiveLayer	Sets the active layer. Inherited from dundas.controls.Canvas.
	setAdapterContextFocus	Inherited from dundas.controls.Canvas.
	setContextState	Restore this control to the state as defined. Inherited from dundas.controls.FocusableControl.
	setDoubleTapToZoom	Turns on/off double tapping the canvas to cause a zoom. Inherited from dundas.controls.Canvas.
	setModalAdapter	Inherited from dundas.controls.Canvas.
	setSnap	Set the snap distance of the design surface. Inherited from dundas.controls.Canvas.
	setVision	Set the current vision of the canvas. Inherited from dundas.controls.Canvas.
	setVisionCoordinate	Set the current vision of the canvas as a coordinate. Inherited from dundas.controls.Canvas.
	setWatermark	Sets water mark on the canvas background. Inherited from dundas.controls.Canvas.
	showCanvas	Shows the canvas and taskbar. Inherited from dundas.controls.Canvas.
	showDropZone	Show the drop zones. Inherited from dundas.controls.Canvas.
	showResizer	Shows the template cell resizer. Inherited from dundas.controls.Canvas.
	subscribe	Subscribe or unsubscribe an event handler for an event. Inherited from dundas.EventDisposable.
	subscribeAdapterInputEvents	Subscribe input event handlers for adapters. Inherited from dundas.controls.Canvas.
	subscribeBackgroundChanged	Subscribe a handler for the background changed event. Inherited from dundas.controls.Canvas.
	subscribeBackgroundResized	Inherited from dundas.controls.Canvas.
	subscribeBlurred	Inherited from dundas.controls.FocusableControl.
	subscribeCanvasLoadedEvent	Subscribe a handler to the canvasloaded event. Inherited from dundas.controls.Canvas.
	subscribeCanvasScrolledEvent	Inherited from dundas.controls.Canvas.
	subscribeContextFocusChanged	Subscribe a handler for the context focus changed event. Inherited from dundas.controls.Canvas.
	subscribeDisposed	Subscribe to the disposed event. Inherited from dundas.EventDisposable.
	subscribeFocused	Inherited from dundas.controls.FocusableControl.
	subscribeOnce	Subscribe a one time event handler for an event. Inherited from dundas.EventDisposable.
	subscribeViewModeChanged	Fires when the viewmode if changed. Inherited from dundas.controls.Canvas.
	subscribeViewportResized	Subscribe an event handler for try viewport resized event. Inherited from dundas.controls.Canvas.
	toggleTemplateCellResizers	Turns on or off the template cells resizers. Inherited from dundas.controls.Canvas.
	toJSON	Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.
	trigger	Raise an event. Inherited from dundas.EventDisposable.
	unbind	Unsubscribe an event. if handler is specified, unsubscribe that handler. if no parameters are specified, unbind everything. Inherited from dundas.EventDisposable.
	unbindAll	unsubscribe all events. Inherited from dundas.EventDisposable.
	ungroup	Ungroup the groups. Inherited from dundas.controls.Canvas.
	ungroupTemplateCells	Ungroup a template cell group. Inherited from dundas.controls.Canvas.
	updateViewport	Notify the canvas that the viewport has been modified. Inherited from dundas.controls.Canvas.
	windowResize	Notify the canvas that the canvas DOM element is resized. Inherited from dundas.controls.Canvas.
	zoomView	Zooms into the canvas, and record a state, so next time zoomView is called the vision is restored. Inherited from dundas.controls.Canvas.